<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FabGL: terminal.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">FabGL
   </div>
   <div id="projectbrief">ESP32 Display Controller and Graphics Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('terminal_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle"><div class="title">terminal.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>This file contains <a class="el" href="classfabgl_1_1_terminal.html" title="An ANSI-VT100 compatible display terminal.">fabgl::Terminal</a> definition.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;ctype.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &quot;freertos/FreeRTOS.h&quot;</code><br />
<code>#include &quot;freertos/task.h&quot;</code><br />
<code>#include &quot;freertos/timers.h&quot;</code><br />
<code>#include &quot;freertos/semphr.h&quot;</code><br />
<code>#include &quot;Arduino.h&quot;</code><br />
<code>#include &quot;Stream.h&quot;</code><br />
<code>#include &quot;<a class="el" href="fabglconf_8h_source.html">fabglconf.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="canvas_8h_source.html">canvas.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="keyboard_8h_source.html">devdrivers/keyboard.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="terminfo_8h_source.html">terminfo.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="soundgen_8h_source.html">devdrivers/soundgen.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for terminal.h:</div>
<div class="dyncontent">
<div class="center"><img src="terminal_8h__incl.png" border="0" usemap="#aterminal_8h" alt=""/></div>
<map name="aterminal_8h" id="aterminal_8h">
<area shape="rect" title="This file contains fabgl::Terminal definition." alt="" coords="4579,5,4657,32"/>
<area shape="rect" title=" " alt="" coords="5,80,71,107"/>
<area shape="rect" title=" " alt="" coords="95,80,160,107"/>
<area shape="rect" title=" " alt="" coords="4642,543,4786,569"/>
<area shape="rect" title=" " alt="" coords="4101,461,4207,487"/>
<area shape="rect" title=" " alt="" coords="4751,461,4869,487"/>
<area shape="rect" title=" " alt="" coords="3939,543,4062,569"/>
<area shape="rect" title=" " alt="" coords="5367,543,5445,569"/>
<area shape="rect" title=" " alt="" coords="4682,80,4757,107"/>
<area shape="rect" href="fabglconf_8h.html" title="This file contains FabGL library configuration settings, like number of supported colors,..." alt="" coords="4893,461,4980,487"/>
<area shape="rect" href="canvas_8h.html" title="This file contains fabgl::Canvas definition." alt="" coords="4194,304,4269,331"/>
<area shape="rect" href="keyboard_8h.html" title="This file contains fabgl::Keyboard definition." alt="" coords="4504,155,4655,181"/>
<area shape="rect" href="terminfo_8h.html" title="This file contains terminal emulation definitions." alt="" coords="4578,80,4658,107"/>
<area shape="rect" href="soundgen_8h.html" title="This file contains all classes related to FabGL Sound System." alt="" coords="5253,379,5407,405"/>
<area shape="rect" title=" " alt="" coords="4928,543,5009,569"/>
<area shape="rect" title=" " alt="" coords="4475,461,4540,487"/>
<area shape="rect" title=" " alt="" coords="4381,461,4450,487"/>
<area shape="rect" href="displaycontroller_8h.html" title="This file contains fabgl::BitmappedDisplayController definition." alt="" coords="4091,379,4217,405"/>
<area shape="rect" title=" " alt="" coords="3960,461,4076,487"/>
<area shape="rect" href="fabutils_8h.html" title="This file contains some utility classes and functions." alt="" coords="4231,461,4306,487"/>
<area shape="rect" title=" " alt="" coords="4506,543,4597,569"/>
<area shape="rect" title=" " alt="" coords="4086,543,4190,569"/>
<area shape="rect" title=" " alt="" coords="4215,543,4323,569"/>
<area shape="rect" title=" " alt="" coords="4347,543,4481,569"/>
<area shape="rect" title=" " alt="" coords="4810,543,4903,569"/>
<area shape="rect" href="ps2device_8h.html" title="This file contains fabgl::PS2Device definition." alt="" coords="4765,304,4925,331"/>
<area shape="rect" href="fabui_8h.html" title="This file contains all classes related to FabGL Graphical User Interface." alt="" coords="4333,229,4394,256"/>
<area shape="rect" href="codepages_8h.html" title="This file contains codepages declarations." alt="" coords="3869,304,3965,331"/>
<area shape="rect" href="kbdlayouts_8h.html" title="This file contains keyboard layouts." alt="" coords="4343,379,4439,405"/>
<area shape="rect" href="ps2controller_8h.html" title="This file contains fabgl::PS2Controller definition." alt="" coords="4666,379,4773,405"/>
<area shape="rect" title=" " alt="" coords="4344,304,4383,331"/>
<area shape="rect" href="fabfonts_8h_source.html" title=" " alt="" coords="2211,379,2291,405"/>
<area shape="rect" title=" " alt="" coords="399,461,515,487"/>
<area shape="rect" title=" " alt="" coords="539,461,655,487"/>
<area shape="rect" title=" " alt="" coords="679,461,795,487"/>
<area shape="rect" title=" " alt="" coords="819,461,935,487"/>
<area shape="rect" title=" " alt="" coords="959,461,1075,487"/>
<area shape="rect" title=" " alt="" coords="1099,461,1222,487"/>
<area shape="rect" title=" " alt="" coords="1246,461,1369,487"/>
<area shape="rect" title=" " alt="" coords="1393,461,1515,487"/>
<area shape="rect" title=" " alt="" coords="1539,461,1662,487"/>
<area shape="rect" title=" " alt="" coords="1686,461,1809,487"/>
<area shape="rect" title=" " alt="" coords="1833,461,1955,487"/>
<area shape="rect" title=" " alt="" coords="1980,461,2096,487"/>
<area shape="rect" title=" " alt="" coords="2120,461,2236,487"/>
<area shape="rect" title=" " alt="" coords="2415,461,2538,487"/>
<area shape="rect" title=" " alt="" coords="2562,461,2685,487"/>
<area shape="rect" title=" " alt="" coords="2709,461,2831,487"/>
<area shape="rect" title=" " alt="" coords="2855,461,2978,487"/>
<area shape="rect" title=" " alt="" coords="3002,461,3125,487"/>
<area shape="rect" title=" " alt="" coords="2261,461,2391,487"/>
<area shape="rect" title=" " alt="" coords="3149,461,3308,487"/>
<area shape="rect" title=" " alt="" coords="3333,453,3463,495"/>
<area shape="rect" title=" " alt="" coords="3487,453,3618,495"/>
<area shape="rect" title=" " alt="" coords="3642,461,3789,487"/>
<area shape="rect" title=" " alt="" coords="3813,453,3935,495"/>
<area shape="rect" title=" " alt="" coords="235,453,374,495"/>
<area shape="rect" title=" " alt="" coords="5273,461,5387,487"/>
<area shape="rect" title=" " alt="" coords="5412,461,5539,487"/>
<area shape="rect" title=" " alt="" coords="5563,461,5652,487"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="terminal_8h__dep__incl.png" border="0" usemap="#aterminal_8hdep" alt=""/></div>
<map name="aterminal_8hdep" id="aterminal_8hdep">
<area shape="rect" title="This file contains fabgl::Terminal definition." alt="" coords="532,5,611,32"/>
<area shape="rect" href="fabgl_8h.html" title="This file is the all in one include file. Application can just include this file to use FabGL library..." alt="" coords="459,155,521,181"/>
<area shape="rect" href="serialport_8h.html" title="This file contains fabgl::SerialPort definition." alt="" coords="528,80,615,107"/>
<area shape="rect" href="terminal_8cpp_source.html" title=" " alt="" coords="639,80,733,107"/>
<area shape="rect" href="_m_c146818_8h_source.html" title=" " alt="" coords="27,229,123,256"/>
<area shape="rect" href="_p_c8250_8h.html" title="This file contains fabgl::PC8250 definition." alt="" coords="154,229,234,256"/>
<area shape="rect" href="_p_i_c8259_8h_source.html" title=" " alt="" coords="273,229,357,256"/>
<area shape="rect" href="_p_i_t8253_8h_source.html" title=" " alt="" coords="393,229,475,256"/>
<area shape="rect" href="_v_i_a6522_8h.html" title="This file contains fabgl::VIA6522 definition." alt="" coords="506,229,589,256"/>
<area shape="rect" href="graphicsadapter_8h.html" title="This file contains fabgl::GraphicsAdapter definition." alt="" coords="624,229,748,256"/>
<area shape="rect" href="i8042_8h_source.html" title=" " alt="" coords="786,229,850,256"/>
<area shape="rect" href="i8086_8h_source.html" title=" " alt="" coords="887,229,951,256"/>
<area shape="rect" href="_m_c146818_8cpp_source.html" title=" " alt="" coords="5,304,116,331"/>
<area shape="rect" href="_p_c8250_8cpp_source.html" title=" " alt="" coords="140,304,235,331"/>
<area shape="rect" href="_p_i_c8259_8cpp_source.html" title=" " alt="" coords="259,304,358,331"/>
<area shape="rect" href="_p_i_t8253_8cpp_source.html" title=" " alt="" coords="382,304,478,331"/>
<area shape="rect" href="_v_i_a6522_8cpp_source.html" title=" " alt="" coords="503,304,600,331"/>
<area shape="rect" href="graphicsadapter_8cpp_source.html" title=" " alt="" coords="625,304,763,331"/>
<area shape="rect" href="i8042_8cpp_source.html" title=" " alt="" coords="788,304,867,331"/>
<area shape="rect" href="i8086_8cpp_source.html" title=" " alt="" coords="891,304,969,331"/>
<area shape="rect" href="serialport_8cpp_source.html" title=" " alt="" coords="545,155,645,181"/>
</map>
</div>
</div>
<p><a href="terminal_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfabgl_1_1_line_editor.html">LineEditor</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classfabgl_1_1_line_editor.html" title="LineEditor is a single-line / multiple-rows editor which uses the Terminal object as input and output...">LineEditor</a> is a single-line / multiple-rows editor which uses the <a class="el" href="classfabgl_1_1_terminal.html" title="An ANSI-VT100 compatible display terminal.">Terminal</a> object as input and output.  <a href="classfabgl_1_1_line_editor.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfabgl_1_1_terminal.html">Terminal</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An ANSI-VT100 compatible display terminal.  <a href="classfabgl_1_1_terminal.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfabgl_1_1_terminal_controller.html">TerminalController</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classfabgl_1_1_terminal_controller.html" title="TerminalController allows direct controlling of the Terminal object without using escape sequences.">TerminalController</a> allows direct controlling of the <a class="el" href="classfabgl_1_1_terminal.html" title="An ANSI-VT100 compatible display terminal.">Terminal</a> object without using escape sequences.  <a href="classfabgl_1_1_terminal_controller.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga58734f6595a1eefb555afc0f1897fc3f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___enumerations_ga58734f6595a1eefb555afc0f1897fc3f.html#ga58734f6595a1eefb555afc0f1897fc3f">CharStyle</a> { <br />
&#160;&#160;<a class="el" href="group___enumerations_ga58734f6595a1eefb555afc0f1897fc3f.html#gga58734f6595a1eefb555afc0f1897fc3faa529a7a50505042b4f78439ecc3fb0d6">Bold</a>
, <a class="el" href="group___enumerations_ga58734f6595a1eefb555afc0f1897fc3f.html#gga58734f6595a1eefb555afc0f1897fc3fa01a8eb7c512c56e42383b0564f4e1514">ReducedLuminosity</a>
, <a class="el" href="group___enumerations_ga58734f6595a1eefb555afc0f1897fc3f.html#gga58734f6595a1eefb555afc0f1897fc3fac2a214096085052039c5b35d6aae7bd0">Italic</a>
, <a class="el" href="group___enumerations_ga58734f6595a1eefb555afc0f1897fc3f.html#gga58734f6595a1eefb555afc0f1897fc3faa909c5f2b588ba35fcc40b3b504ad2ed">Underline</a>
, <br />
&#160;&#160;<a class="el" href="group___enumerations_ga58734f6595a1eefb555afc0f1897fc3f.html#gga58734f6595a1eefb555afc0f1897fc3fa1608aa89b3f44882080cfaa7536c1cde">Blink</a>
, <a class="el" href="group___enumerations_ga58734f6595a1eefb555afc0f1897fc3f.html#gga58734f6595a1eefb555afc0f1897fc3fae885c31e41fc9fcb8ac14496dc4346df">Blank</a>
, <a class="el" href="group___enumerations_ga58734f6595a1eefb555afc0f1897fc3f.html#gga58734f6595a1eefb555afc0f1897fc3fa17e68c01437379e2ee2ae4ad92a918ac">Inverse</a>
<br />
 }</td></tr>
<tr class="memdesc:ga58734f6595a1eefb555afc0f1897fc3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This enum defines a character style.  <a href="group___enumerations_ga58734f6595a1eefb555afc0f1897fc3f.html#ga58734f6595a1eefb555afc0f1897fc3f">More...</a><br /></td></tr>
<tr class="separator:ga58734f6595a1eefb555afc0f1897fc3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab18ae5ee717bbc4b0722f7c3f5cffbf6"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___enumerations_gab18ae5ee717bbc4b0722f7c3f5cffbf6.html#gab18ae5ee717bbc4b0722f7c3f5cffbf6">LineEditorSpecialChar</a> { <a class="el" href="group___enumerations_gab18ae5ee717bbc4b0722f7c3f5cffbf6.html#ggab18ae5ee717bbc4b0722f7c3f5cffbf6a49176da75a1269d7cda14dd52331c7da">CursorUp</a>
, <a class="el" href="group___enumerations_gab18ae5ee717bbc4b0722f7c3f5cffbf6.html#ggab18ae5ee717bbc4b0722f7c3f5cffbf6a3f96d33d45dfd7be341bf60569f3e623">CursorDown</a>
 }</td></tr>
<tr class="memdesc:gab18ae5ee717bbc4b0722f7c3f5cffbf6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Special character specified in on values from LineEditor::onSpecialChar delegate.  <a href="group___enumerations_gab18ae5ee717bbc4b0722f7c3f5cffbf6.html#gab18ae5ee717bbc4b0722f7c3f5cffbf6">More...</a><br /></td></tr>
<tr class="separator:gab18ae5ee717bbc4b0722f7c3f5cffbf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1743e3458e6f97a06488133ec83ba679"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___enumerations_ga1743e3458e6f97a06488133ec83ba679.html#ga1743e3458e6f97a06488133ec83ba679">TerminalTransition</a> {  }</td></tr>
<tr class="memdesc:ga1743e3458e6f97a06488133ec83ba679"><td class="mdescLeft">&#160;</td><td class="mdescRight">This enum defines terminal transition effect.  <a href="group___enumerations_ga1743e3458e6f97a06488133ec83ba679.html#ga1743e3458e6f97a06488133ec83ba679">More...</a><br /></td></tr>
<tr class="separator:ga1743e3458e6f97a06488133ec83ba679"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >This file contains <a class="el" href="classfabgl_1_1_terminal.html" title="An ANSI-VT100 compatible display terminal.">fabgl::Terminal</a> definition. </p>

<p class="definition">Definition in file <a class="el" href="terminal_8h_source.html">terminal.h</a>.</p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="terminal_8h.html">terminal.h</a></li>
    <li class="footer">Generated on Mon Aug 29 2022 13:52:05 for FabGL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 </li>
  </ul>
</div>
</body>
</html>
